home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus Extra 1997 #1 / Amiga Plus Extra 1997 #1.iso / programme / tools / htmless / htmless.doc < prev    next >
Text File  |  1996-11-25  |  16KB  |  409 lines
  1. *****************************************
  2. *        `HTMLess'  v2.3        *
  3. *       An OriginalWare release by      *
  4. *        Troglobyte/Darkness        *
  5. *****************************************
  6. $VER:HTMLess.doc v2.3 30.Nov.96 Troglobyte/Darkness
  7.  
  8. Contents
  9. ========
  10.  
  11. 1. Introduction
  12. 2. Workbench usage and ToolTypes
  13. 3. CLI usage
  14. 4. History
  15. 5. Bugs
  16. 6. OriginalWare?
  17. 7. Also available...
  18. 8. Thanks to...
  19. 9. Credits
  20.  
  21. 1. Introduction
  22. ===============
  23.  
  24. HTMLess is just another utility to extract the text inside HTML files (Web
  25. pages) and convert it to a readable text format.It can be used to test your
  26. own Web pages, if you get any strange text as result, will mean an error in
  27. the HTML source code (or a bug in my program :).
  28.  
  29. I released the first version in April'96, since then I received lot of EMails
  30. with bugs, ideas and support who keep me busy developing and improving HTMLess,
  31. I released 5 improved versions, today (30.Nov.96) a new release is ready: v2.3,
  32. I hope this new version could fill the needs of everybody, my goal was a
  33. small, eficient, fast, easy to use and reliable Amiga program to convert Web
  34. HTML pages to readable text files.I hope all you will find HTMLess useful.
  35.  
  36. The main features are:
  37.  
  38.  - Fast, written 100% in assembler. (Even faster since v1.2, and the fastest
  39.    with the new in v1.3 CLI option -w or the ToolType WINDOW disabled)
  40.  - Small but powerful utility (only 12000 bytes long).
  41.  - CLI and Workbench usage.
  42.  - ToolTypes support.                         [New since v2.0]
  43.  - Admit filenames as CLI parameters (can be launched from a
  44.    DiskMaster/DirOpus type program to autoconvert HTML's).
  45.  - All non-ASCII chars are converted.
  46.  - Output text could be formatted to any number of columns for easy reading.
  47.  - Can keep [href's] (like WWW adresses) in the output text.
  48.  - Can keep META info and internal comments in the output text.    [New since v2.3]
  49.  - .HTML or .HTM filename suffix could be changed to your own defined text
  50.    extension.                             [New since v2.0]
  51.  - The program will report any kind of errors.
  52.  - Very easy to use...just try it.
  53.  - WYSIAWYG (WhatYouSawIsAlmostWhatYouGet)
  54.  - Great results (complex AI routines used *8).
  55.  - HTML Lists converted to text lists.
  56.  - `HTMLess' is a wonderful name. 
  57.  - No annoying requesters when starting/using/quitting program.
  58.  - It's OriginalWare (OriginalWhat?) and it's only Amiga (Yeah!).
  59.  
  60. The only requirement is the "ReqTools.library" by Nico Francois and Magnus
  61. Holmgren who fortunately is continuing the development of the indispensable
  62. reqtools library.
  63.  
  64. If you need a custom version of this program (for a personal necessity);
  65. contact me and I will try to make a customized version for you (if it isn't
  66. too difficult or too much work).
  67.  
  68. If you think the sources (100% assembler) could be useful for you (to include
  69. in a program you are developing or for learning purposes) just contact me and
  70. ask for them.
  71.  
  72.  
  73. 2. Workbench usage and ToolTypes
  74. ================================
  75.  
  76. 2.1 Workbench usage:
  77.  
  78. Just launch the program and use the file requester to select the HTML file to
  79. load and to choose the name to save the text file.
  80. (Since v1.1 this `complex' option works *8)
  81. [New since v1.2]
  82. The program will ask for another filename after saving the converted file,
  83. when you don't have more HTML files to convert, Cancel or Close the file
  84. requester to exit. (Use the icon ToolType SINGLE for just one use)
  85.  
  86. 2.2 ToolTypes [New since v2.0]
  87.  
  88. The ToolTypes of the icon will be used as default configuration.
  89. The ToolTypes are equivalent to the CLI options, but if used, all the CLI
  90. options will prevail over the ToolTypes options.
  91.  
  92. COLUMNS=x    Number of columns to format the text (x is a number, 0<x<9999)
  93.         (If x=0 the text will be `formated' like the original file)
  94. HTTP        Insert href's in the output text between "[...]" chars.
  95. WINDOW        Open a Workbench window to display info.This option is
  96.         incompatible with YAK commodity, if you use YAK disable this.
  97. SINGLE        Convert just one file and exit without asking for a new file.
  98. AUTOSAVE    Save the text without a file requester.
  99. OVERWRITE    Overwrite the original HTML file, so use with caution.
  100. EXTENSION=text  Add a text extension to the savename.
  101. PATH=Dir    Select the default start directory.
  102. [New since v2.3]
  103. META        Insert META info and comments of the HTML source file in the
  104.         output text between "{...}" chars.
  105.  
  106. To disable options use brackets with the ToolType.
  107. Example : 
  108. WINDOW        Window enabled
  109. (WINDOW)    Window disabled
  110.  
  111.  
  112. 3. CLI usage
  113. ============
  114.  
  115. Just write the command `HTMLess' with your favourite options in any CLI/Shell
  116. window.
  117.  
  118.  `HTMLess [?] [-Cxx] [-H] [-M] [-W] [-S] [-A] [-O] [-E...] [-P] [filename/path]'
  119.  
  120. Write just the options or the options and the path or filename (if not
  121. filename is given or if there is any kind of problem a file requester
  122. will be used with your defined path).
  123. Options must be ahead of the file name and must be after a "-" char.
  124. Options can be together or alone (-c20h or -c -h20),  and written in capital
  125. or small letters (-HC5, -hc5 or -hC5)
  126. The -Etext option must be used separated from the others options (-hc5 -e.txt)
  127. to avoid the confusion of taking the text as a CLI option.
  128.  
  129. The available options are: 
  130.  -h     : if used "href's" will be removed.By default "href's" are included
  131.           in the output text between "[...]" chars.
  132.  -cXXXX : XXXX are 1 to 4 numbers (-c10,-c200,-c0080) to select the size of
  133.           the columns of the formated text (default size is 80 columns).
  134.       If the number is zero, text won't be formatted (-c0,-c0000)
  135. [New since v1.2]
  136.  ?, -? or -help : give CLI USAGE: info.
  137. [New since v1.3]
  138.  -w     : when used HTMLess window won't be opened.And the conversion will
  139.           be really faster; try it.Errors will be reported to the CLI
  140.           window, if there is any opened.
  141.  -p     : you can define the path to your favourite HTML directory
  142.       Used without specifying later a [path] is useless.
  143. [New since v2.0]
  144.  -s     : Single use, 
  145.  -a     : AutoSave, save without a requester asking for the filename. 
  146.  -o     : Overwrite, use with caution, will overwrite original file.
  147.  -e.TXT : Add a text extension to the original filename (you define the text).
  148.       .HTML or .HTM extensions are automatically removed.
  149. [New since v2.3]
  150.  -m     : if used "META" info and comments will be added in the output text
  151.        between "{...}" chars.By default, META info and comments are removed.
  152.  
  153.  
  154. Examples:
  155.  
  156. 1. HTMLess -hc80 File1.html
  157.    Results : A text file "File1.text" without [href's] and formated to 80
  158.              columns will be saved.
  159.  
  160. 2. HTMLess -h -c0040 File2.htm
  161.    Results : A text file "File2.txt" without [href's] and formated to 40
  162.              columns will be saved.
  163.  
  164. 3. HTMLess -c0 File3.txt
  165.    Results : A text file with the same name "File3.txt" with [href's] and
  166.    unformated text will be saved.
  167.  
  168. 4. HTMLess -p RAM:Temp/HTML    (RAM:Temp/HTML is a path, not a file)
  169.    Results : File requester with the files in the directory: `RAM:Temp/HTML/...'
  170.  
  171. 5. HTMLess -e.Document File4.html
  172.    Results : A text file with the name "File4.Document"
  173.  
  174.  
  175. Common errors :
  176.  
  177. 1. Options must be after a "-" char always.
  178.    BAD: HTMLess -h c80 File1.html
  179.    OK : HTMLess -hc80 File1.html
  180.    OK : HTMLess -h -c80 File1.html
  181.  
  182. 2. Options must be ahead of the filename.
  183.    BAD: HTMLess File1.htm -c20h
  184.    OK : HTMLess -c20h File1.htm
  185.    
  186.  
  187. 4. History
  188. ==========
  189.  
  190. Version 1.0 ( 1.April.1996) :
  191.  - First official release.
  192.  
  193. Version 1.1 ( 5.April.1996) :
  194.  - Fixed Workbench icon bug (Sorry about that stupid icon type error).
  195.  - All non-ASCII chars are supported now. (Not really, try v1.2)
  196.  - Improved conversion of HTML Lists (now are more readable).
  197.  - Some extra Line Feeds are removed (but not all, to make readable a lot
  198.    of not-very-standard HTML Web pages)
  199.  - A rarely Guru bug with small files fixed.
  200.  - Last char of the text isn't deleted now.
  201.  
  202. Version 1.2 (12.April.1996) :
  203.  - Even more speed: a lot faster when Fast memory is available. (Test it)
  204.  - You can convert several files without reloading HTMLess.  (Otto von Ruggins)
  205.  - ">" by "}", and "<" by "{" bug removed.              (Markus Krajewski)
  206.  - CLI Usage info.                              (Alfredo Soro)
  207.  - All non-ASCII chars are supported now (I said the same in v1.1 *8)
  208.  - Some rare and little system-unfriendly bugs removed.
  209.  - Improved conversion for some HTML commands ( </P>, <DT> y <H....>)
  210.  - Spaces removed at the end of lines.
  211.  - More helpful people included in this doc (Look: 6.Thanks to... *8)
  212.  
  213. Version 1.3 (16.April.1996) :
  214.  - New CLI option. -w : no window will be opened and the conversion is FASTER.
  215.  - New CLI option. -p : will permit define your own path as default dir.
  216.  - Problem with YAK commodity detected, but not fixed yet.      (John Turgoose) 
  217.  - Even more helpful people included in this doc (Look: 8.Thanks to... *8)
  218.  
  219. Version 2.0 ( 1.May.1996) :
  220.  - Added Workbench icon ToolTypes support (All the CLI options have a ToolType)
  221.  - Almost all the duplicated text titles are removed now.
  222.  - Bug fixed: filesize limit of 64 KB removed.              (Markus Krajewski)
  223.  - Bug fixed: TABS (tabulator chars) are accepted.         (Markus Krajewski)
  224.  - New WB/CLI option. -A : AutoSave, no save-filename requester. 
  225.  - New WB/CLI option. -O : OverWrite original file! (Use with caution!)
  226.  - New WB/CLI option. -S : Single use, convert just one file and exit.
  227.  - New WB/CLI option. -E.text : Add a text extension to the filename. 
  228.  - Still even more helpful people included in this doc (Read: 8.Thanks to...*8)
  229.  
  230. Version 2.1 (23.Jul.1996) :
  231.  - Lame Bug fixed: Now works without Fast RAM. (I.Gallego, G.A.Gomez & I.Sofke)
  232.  - Still even more helpful people included in this doc (Read: 8.Thanks to...*8)
  233.  
  234. Version 2.2 (20.Nov.1996) :
  235.  - Now META info can be included in the text betwen {...} chars.
  236.  - Bug fixed: filename betwen "..." chars are acepted.          (Eric Giroux)
  237.  - Still even more helpful people included in this doc (Read: 8.Thanks to...*8)
  238.  
  239. Version 2.3 (30.Nov.1996) :
  240.  - Now META info and comments can be included in the text betwen {...} chars,
  241.    with the ToolType META or the CLI option: -M.
  242.  - Improved conversion for clearer formated output results.
  243.  - This Doc was fully revised and updated.
  244.  - Bug fixed: sometimes the first and last lines were cutted.
  245.  - Bug fixed: duplicated titles removed of the new text file.
  246.  
  247.  
  248. ToDo List:
  249.  - Fix all the bugs that will be discovered by users (Don't try so hard *8)
  250.  - Fix the strange YAK BUG listed in `5. Bugs'.
  251.  - Display improved formated LISTS.
  252.  - Display improved formated TABLES.
  253.  - Option to convert bold and italic tags as ANSI.
  254.  
  255.  
  256. 5. Bugs
  257. =======
  258.  
  259. [New since v1.3]
  260. There is an unknown bug in some Amigas, looks like there is a compatibility
  261. problem with the YAK commodity (thanks to John Turgoose for this info).So
  262. try to disable/unload/stop/turn off YAK when using HTMLess.
  263. The problem is a warning Guru (yellow) each time you run HTMLess, after
  264. that you can't close the HTMLess window.Since v1.3 I included a new CLI option
  265. (-w), when used HTMLess don't open his own window, but will report errors
  266. to the CLI window, if it's open.As an added bonus with this option turned
  267. on the conversion is a lot faster.
  268.  
  269. There isn't anymore KNOWN bugs at the moment in all the Amigas tested but...
  270.  
  271. If you find any bug or problem, contact me at the previous address.Please,
  272. send me a detailed report of the problem and of your Amiga computer if
  273. possible; thanks.
  274.  
  275. If you found the problem with a particular file, send me too a copy of
  276. the file.
  277.  
  278. Don't forget to tell me the current version of my program you are using.
  279.  
  280.  
  281. 6. OriginalWare ?
  282. =================
  283.  
  284. This  utility  is OriginalWare.That means if you like this program you must
  285. buy  an  original Amiga program or game, or send the money to the author of
  286. any ShareWare program or game you are using often.
  287. (This includes me, $5 or $10 will be welcome *8)
  288.  
  289. There  are  lots  of  great Amiga software like `DiskMaster', `Remind',
  290. `MultiCX', `Spot', `ReqTools.library', `Deluxe Galaga', `APlayer' and a
  291. lot more that you won't never regret to spend your money.
  292.  
  293. If you do this you support the Amiga, and if you support AMIGA you support
  294. US.Support software authors and you will get more and better software.
  295.  
  296.  
  297. This program could be included in any PD compilation at a symbolic price,
  298. but you must send me a copy of the CD/Floppy Disk/... compilation or get
  299. a written permission from me.
  300.  
  301. Aminet and Fred Fish collections are specifically allowed to include it
  302. absolutely free.
  303.  
  304. This program could be freely included in any Web page or FTP site, but
  305. send me an EMail to know it (I can include your page address in this doc).
  306.  
  307. For using this in commercial products, my written permission is required.
  308. Inclusion in magazines and diskmags will be allowed, if you send me a copy of
  309. this publication.
  310.        
  311.  
  312. 7. Also available...
  313. ====================
  314.  
  315. Others quality Amiga PD products available from me :
  316.  
  317. Aminet recent uploads :
  318.  
  319. HTMLess.lha   v2.3   text/hyper     15K v2.3 Converts HTML files in text files.
  320. DarkSound.lha v2.5   util/boot   53K v2.5 Changes Workbench Sounds each boot.
  321. MagiCA64.lha  v1.1   misc/emu     6K Converts A64/64 files to MagiC64 format.  
  322. Progress.lha  v1.0   demo/intro  73K In Progress/Darkness.1st at Euskal Party
  323. Vectoram.lha  v1.3   dev/misc    15K Draw and edit 2D vectors for demos/games
  324. TheRace5.lha  v1.5   game/2play  59K Great 100m Running game, 0-4 players.
  325.  
  326. Available soon:
  327.  
  328. ELF.lha       v1.0   text/misc         Erase Line Feeds.Use for Word Procesors.
  329. FormaText.lha v1.0   text/misc         Format texts to your chosen columns size 
  330.  
  331. All them are 100% written in pure assembler for speed and are very system 
  332. friendly in all types of Amiga computers (or that is what I hope *8).
  333.  
  334.  
  335. 8. Thanks to...
  336. ===============
  337.  
  338. First a very special THANK to Jon B. Peterson from San Angelo (Texas, USA),
  339. for being the first (and only) ever person to send me some money for my work.
  340.  
  341. Alfredo Soro.es for the first ßeta testing.
  342. Otto Von Ruggins for the first bug report and some tests.
  343. Philippe Duchenne.be for reporting some bugs and interesting ideas.
  344. Markus Krajewski.de for lots of bugs and nice ideas.
  345. Geoff Milnes for another bug report.
  346. John Turgoose.ca for the problem with the YAK commodity.
  347. Jerome Chesnot.fr for EMail support, even "TheRace" support. (R.A.M. is great!)
  348. David Cassidy.uk for don't forget me *8) .
  349. Jose Vergara.es for Fido EMail support.
  350. Andrew Bruno.au for EMail support. 
  351. Mikael Osterhed.it for EMail support.
  352. Glenn Zieman for EMail support and suggestions.
  353. Joerg Plate.de for EMail suggestions.
  354. Derik Pyper.ca for nice EMail support.
  355. Adriano Altorio.it for EMail support.
  356. David de Groot.be for nice EMail support.
  357. Dareen Enns for EMail suggestions.
  358. Peter Soderber.se for EMail support.
  359. Ignacio Gallego.es for the Fast RAM bug.
  360. Gustavo Adolfo Gomez.ve for the Fast RAM bug and nice EMail.
  361. Ivan Sofic.yu for the Fast RAM bug report.
  362. Eric Giroux for the filename betwen "..." chars loading bug.
  363.  
  364. Hipnooxis.es for ALL the help and show me to use and respect the Amiga O.S.
  365.  
  366. Knackosoft.de/TRSI for being my best `invisible' friend.
  367.  
  368. To the `Atletico de Madrid', the best football team in Spain.
  369.  
  370. To all the Amiga developers for all the new, fun and useful stuff.
  371.  
  372. To all the Amiga users (you!) worldwide for their trust in the Amiga.
  373.  
  374. To Amiga Technologies for continue the development of the Amiga...for a while.
  375.  
  376. To VIScorp for continue the development of the Amiga ?
  377.  
  378. To the Amiga...
  379.  
  380.  
  381. 9. Credits
  382. ==========
  383.  
  384. All code © 1996 by Troglobyte/Darkness.
  385.  
  386. Send money ($), JOB offers, BUGS, comments, improvements, ideas, advices,
  387. suggestions, mags, complains, and nice  PD  stuff  (like Demos, Games or
  388. Utilities).
  389.  
  390.             M. Martin Vivaldi
  391.              Av. America 60
  392.               Madrid 28028
  393.                  SPAIN
  394.  
  395. Or NetMail me at :
  396.  
  397.  Internet : bitabit@servicom.es (Faster and safer)
  398.  
  399.  FidoNet  : 2:341/28.55        Manuel Martin
  400.  
  401.  AmigaNet : 39:192/1.29        Manuel Martin
  402.  
  403.  
  404. Remember:
  405.  
  406.       Only Amiga make it possible... Only Amiga make it fun.
  407.  
  408.  
  409.